Schema Changes from V3.0 through V4.1

The table below includes elements added in schema versions 3.1 and 4.1. The changes apply to both Online and Batch transactions.

TABLE 1-2 New Elements V3.0 to V4.1

New Element

Parent of

Child of

Comments

taxExempt

--

enhancedData

 

discountAmount

--

enhancedData

 

shippingAmount

--

enhancedData

 

shipFromPostalCode

--

enhancedData

 

destinationPostalCode

--

enhancedData

 

destinationCountryCode

--

enhancedData

 

invoiceReferenceNumber

--

enhancedData

 

orderDate

--

enhancedData

 

detailedTax

taxIncludedInTotal
taxAmount

taxRate

taxTypeIdentifier cardAcceptorTaxId

enhancedData
lineItemData

 

lineItemData

itemSequenceNumber itemDescription

productCode

quantity

unitOfMeasure
taxAmount
lineItemTotal

lineItemTotalWithTax itemDiscountAmount commodityCode

unitCost

detailTax

enhancedData

 

taxIncludedInTotal

--

detailedTax

 

taxAmount

--

detailedTax

lineItemData

 

taxRate

--

detailedTax

 

taxTypeIdentifier

--

detailedTax

 

cardAceptorTaxId

--

detailedTax

 

itemSequenceNumber

--

lineItemData

 

itemDescription

--

lineItemData

 

productCode

--

lineItemData

 

quantity

--

lineItemData

 

unitOfMeasure

--

lineItemData

 

lineItemTotal

--

lineItemData

 

lineItemTotalWithTax

--

lineItemData

 

itemDiscountAmount

--

lineItemData

 

commodityCode

--

lineItemData

 

unitCost

--

lineItemData

 

recyclingRequest

 

recycleBy

recycleId

(added in February 2012)

authorization

sale

Note: This control and its child was added to V3.1 and V4.1 in December 2011 without a revision to the schema version. If you coded to either V3.1 or V4.1 prior to December 2011, you must modify your coding to take advantage of this control.

recycleBy

 

--

recyclingRequest

Used to indicate who merchant or Worldpay) controls recycling of the transaction should it be defined. Also determines where the transaction is counted for the purposes of A/B testing.

recycleId

--

recyclingRequest

Can be used as an alternate to <orderId> in the recycling signature.

Note: This identifier was added to V3.1 and V4.1 in February 2012 without a revision to the schema version. If you coded to either V3.1 or V4.1 prior to February 2012, you must modify your coding to take advantage of this element.

recycling

recycleEngineActive

(added in February 2012)

authorizationRespon se

saleResponse

 

recycleEngineActive

 

--

recycling

Note: This flag was added to V3.1 and V4.1 in February 2012 without a revision to the schema version.If you coded to either V3.1 or V4.1 prior to February 2012, you must modify your coding to take advantage of this element.

recycling

 

creditLitleTxnId

voidResponse

Contains a child element providing the Vantiv transaction Id of an associated credit transaction (see below).

Note: This element was added to V4.1 in January 2013 without a revision to the schema version. If you coded to V4.1 prior to January 2013, you must modify your coding to take advantage of this element.

creditLitleTxnId

 

--

recycling

The Vantiv transaction Id of the credit transaction automatically issued by the system when you use a Void transaction to halt the Recycling Engine, but the transaction is already approved and captured. (Auto-refund option must be enabled.)